SetFeature

The SetFeature webservice can be used to enable Features, and set the status of the Features, attached to a SubscriptionClosed A billing entity that incurs a charge. Examples include a network attached device whose usage you want to measure and charge for, or a monthly software subscription.

This web serviceClosed XML- or JSON-based information exchange systems that use the Internet for direct application-to-application interaction. These systems can include programs, objects, messages, or documents. allows a userClosed A person with the capability to log in to the CMP GUI software, such as a customer service advisor or agent. to set one or multiple Features for a Subscription using either a Subscription Number or NetworkClosed In the context of CMP, the infrastructure on which usage of registered customers will be measured – this could be a mobile phone network, broadband network or other non-telecommunications network. Serial Number.

The FeatureCode and ActionRequired (Enable, Disable, Bar or Unbar) are required to set a Feature. Relevant data is then sent to SubscriberFeature and SubscriberFeatureHistory files.

A Workflow Event is also created in order to change the Feature Status. If the request is successful, the originally submitted ExternalReference is returned to the user.

Some features, both service and non-service, cannot be set using the web service and are only editable through configuration.

SetFeature Request

The SetFeature tag instructs the Features Service to enable and set a Feature for a Subscription. This request contains the following elements:

Element Name

Content Type

Description

Required?

ExternalReference

String69

The client may use this identifier to correlate the request and the response.

Optional

TargetIdentifier

Container - Choice

Choice of:

  • SubscriptionIdentifier, Integer8, the CMP Subscription Number, optional.
  • NetworkSerialNumber, String25, the Network Serial Number associated with the CMP Subscription, optional.

Mandatory

FeatureActions

Container

See FeatureAction Request Container for details.

Mandatory

AuditRecord

Container

See AuditRecord Request Container for details.

Mandatory

FeatureActions Request Container

The FeatureActions request container contains the following elements.

Element Name

Content Type

Description

Required?

FeatureAction

Container

One or more repetitions of the FeatureAction container. See FeatureAction Request Container for details.

Mandatory

FeatureActions Request Container

The FeatureAction request container contains the following elements.

Element Name

Content Type

Description

Required?

FeatureCode

String6

The CMP code of the Feature to be updated.

Mandatory

ActionRequired

String

Options include;

  • Enable
  • Disable

Mandatory

AuditRecord Request Container

The Features AuditRecord request container has the following elements:

Element Name

Content Type

Description

Required?

UserID

String10

User ID associated with the profile. This is the ID which the calling program adds to the records that are created.

Mandatory

Program

String10

The Program Name should be hard coded in the calling application so as to uniquely identify that application.

Mandatory

Sample SetNetworkFeature Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:def="http://mdsuk.com/ws/dise3g/features/definition">
<soapenv:Header/>
<soapenv:Body>
<def:SetFeature>
<def:Request>
<!--You may enter the following 4 items in any order-->
<!--Optional:-->
<ExternalReference>?</ExternalReference>
<TargetIdentifier>
<!--You may enter the following 2 items in any order-->
<!--Optional:-->
<SubscriptionIdentifier>10359190</SubscriptionIdentifier>
<!--Optional:-->
<!-- <NetworkSerialNumber>?</NetworkSerialNumber> -->
</TargetIdentifier>
<FeatureActions>
<!--1 or more repetitions:-->
<FeatureAction>
<!--You may enter the following 2 items in any order-->
<FeatureCode>NF9999</FeatureCode>
<ActionRequired>ENABLE</ActionRequired>
</FeatureAction>
<FeatureAction>
<!--You may enter the following 2 items in any order-->
<FeatureCode>NF0002</FeatureCode>
<ActionRequired>ENABLE</ActionRequired>
</FeatureAction>
</FeatureActions>
<!--Optional:-->
<!-- <AuditRecord>
<UserID>?</UserID>
<Program>?</Program>
</AuditRecord> -->
</def:Request>
</def:SetFeature>
</soapenv:Body>
</soapenv:Envelope>

SetFeature Response

The SetFeature response is the response to the SetFeature Request. It contains the following elements:

Element Name

Content Type

Description

Required?

ExternalReference

String69

Returned unmodified in the response. The client may use this identifier to correlate the request and the response.

Optional

Sample SetFeature Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns2:SetFeatureResponse xmlns:ns2="http://mdsuk.com/ws/dise3g/features/definition" xmlns:ns3="http://mdsuk.com/ws/dise3g/fault/definition">
<ns2:Response>
<ExternalReference>?</ExternalReference>
</ns2:Response>
</ns2:SetFeatureResponse>
</soapenv:Body>
</soapenv:Envelope>